<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Interface Swift_Mime_Header | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li class="active"><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift_Attachment.html">Swift_Attachment</a></li>
				<li><a href="class-Swift_EmbeddedFile.html">Swift_EmbeddedFile</a></li>
				<li><a href="class-Swift_Image.html">Swift_Image</a></li>
				<li><a href="class-Swift_Message.html">Swift_Message</a></li>
				<li><a href="class-Swift_Mime_Attachment.html">Swift_Mime_Attachment</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_Base64ContentEncoder.html">Swift_Mime_ContentEncoder_Base64ContentEncoder</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_PlainContentEncoder.html">Swift_Mime_ContentEncoder_PlainContentEncoder</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_QpContentEncoder.html">Swift_Mime_ContentEncoder_QpContentEncoder</a></li>
				<li><a href="class-Swift_Mime_EmbeddedFile.html">Swift_Mime_EmbeddedFile</a></li>
				<li><a href="class-Swift_Mime_Grammar.html">Swift_Mime_Grammar</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder_Base64HeaderEncoder.html">Swift_Mime_HeaderEncoder_Base64HeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder_QpHeaderEncoder.html">Swift_Mime_HeaderEncoder_QpHeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_Headers_AbstractHeader.html">Swift_Mime_Headers_AbstractHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_DateHeader.html">Swift_Mime_Headers_DateHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_IdentificationHeader.html">Swift_Mime_Headers_IdentificationHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_MailboxHeader.html">Swift_Mime_Headers_MailboxHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_ParameterizedHeader.html">Swift_Mime_Headers_ParameterizedHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_PathHeader.html">Swift_Mime_Headers_PathHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_UnstructuredHeader.html">Swift_Mime_Headers_UnstructuredHeader</a></li>
				<li><a href="class-Swift_Mime_MimePart.html">Swift_Mime_MimePart</a></li>
				<li><a href="class-Swift_Mime_SimpleHeaderFactory.html">Swift_Mime_SimpleHeaderFactory</a></li>
				<li><a href="class-Swift_Mime_SimpleHeaderSet.html">Swift_Mime_SimpleHeaderSet</a></li>
				<li><a href="class-Swift_Mime_SimpleMessage.html">Swift_Mime_SimpleMessage</a></li>
				<li><a href="class-Swift_Mime_SimpleMimeEntity.html">Swift_Mime_SimpleMimeEntity</a></li>
				<li><a href="class-Swift_MimePart.html">Swift_MimePart</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="class-Swift_Mime_CharsetObserver.html">Swift_Mime_CharsetObserver</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder.html">Swift_Mime_ContentEncoder</a></li>
				<li><a href="class-Swift_Mime_EncodingObserver.html">Swift_Mime_EncodingObserver</a></li>
				<li class="active"><a href="class-Swift_Mime_Header.html">Swift_Mime_Header</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_HeaderFactory.html">Swift_Mime_HeaderFactory</a></li>
				<li><a href="class-Swift_Mime_HeaderSet.html">Swift_Mime_HeaderSet</a></li>
				<li><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></li>
				<li><a href="class-Swift_Mime_MimeEntity.html">Swift_Mime_MimeEntity</a></li>
				<li><a href="class-Swift_Mime_ParameterizedHeader.html">Swift_Mime_ParameterizedHeader</a></li>
			</ul>




		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.Mime.html" title="Summary of Swift\Mime"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Interface Swift_Mime_Header</h1>


	<div class="description">
	
<p>A MIME Header.</p>

	</div>





	<div>
		<h4>Direct known implementers</h4>
			<a href="class-Swift_Mime_Headers_AbstractHeader.html">Swift_Mime_Headers_AbstractHeader</a>, 
			<a href="class-Swift_Mime_ParameterizedHeader.html">Swift_Mime_ParameterizedHeader</a>
	</div>

	<div>
		<h4>Indirect known implementers</h4>
			<a href="class-Swift_Mime_Headers_DateHeader.html">Swift_Mime_Headers_DateHeader</a>, 
			<a href="class-Swift_Mime_Headers_IdentificationHeader.html">Swift_Mime_Headers_IdentificationHeader</a>, 
			<a href="class-Swift_Mime_Headers_MailboxHeader.html">Swift_Mime_Headers_MailboxHeader</a>, 
			<a href="class-Swift_Mime_Headers_ParameterizedHeader.html">Swift_Mime_Headers_ParameterizedHeader</a>, 
			<a href="class-Swift_Mime_Headers_PathHeader.html">Swift_Mime_Headers_PathHeader</a>, 
			<a href="class-Swift_Mime_Headers_UnstructuredHeader.html">Swift_Mime_Headers_UnstructuredHeader</a>
	</div>



	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.Mime.html">Mime</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
		<b>Located at</b> <a href="source-class-Swift_Mime_Header.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/Mime/Header.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="getFieldType" id="_getFieldType">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldType">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#39" title="Go to source code">getFieldType</a>( )</code>

		<div class="description short">
			
<p>Get the type of Header that this instance represents.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the type of Header that this instance represents.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>


				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Header.html#TYPE_TEXT">Swift_Mime_Header::<b>TYPE_TEXT</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_PARAMETERIZED">Swift_Mime_Header::<b>TYPE_PARAMETERIZED</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_MAILBOX">Swift_Mime_Header::<b>TYPE_MAILBOX</b></a></code></code><br />
						<code><code><a href="class-Swift_Mime_Header.html#TYPE_DATE">Swift_Mime_Header::<b>TYPE_DATE</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_ID">Swift_Mime_Header::<b>TYPE_ID</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_PATH">Swift_Mime_Header::<b>TYPE_PATH</b></a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="setFieldBodyModel" id="_setFieldBodyModel">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setFieldBodyModel">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#48" title="Go to source code">setFieldBodyModel</a>( <span>mixed <var>$model</var></span> )</code>

		<div class="description short">
			
<p>Set the model for the field body. The actual types needed will vary depending
upon the type of Header.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set the model for the field body. The actual types needed will vary depending
upon the type of Header.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$model</var></dt>
					<dd><code>mixed</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="setCharset" id="_setCharset">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setCharset">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#56" title="Go to source code">setCharset</a>( <span>string <var>$charset</var></span> )</code>

		<div class="description short">
			
<p>Set the charset used when rendering the Header.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set the charset used when rendering the Header.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$charset</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldBodyModel" id="_getFieldBodyModel">

		<td class="attributes"><code>
			 public 
			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldBodyModel">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#63" title="Go to source code">getFieldBodyModel</a>( )</code>

		<div class="description short">
			
<p>Get the model for the field body. The return type depends on the specifics of
the Header.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the model for the field body. The return type depends on the specifics of
the Header.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>mixed</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldName" id="_getFieldName">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldName">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#71" title="Go to source code">getFieldName</a>( )</code>

		<div class="description short">
			
<p>Get the name of this header (e.g. Subject). The name is an identifier and as
such will be immutable.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the name of this header (e.g. Subject). The name is an identifier and as
such will be immutable.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldBody" id="_getFieldBody">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldBody">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#79" title="Go to source code">getFieldBody</a>( )</code>

		<div class="description short">
			
<p>Get the field body, prepared for folding into a final header value.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the field body, prepared for folding into a final header value.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="toString" id="_toString">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_toString">#</a>
		<code><a href="source-class-Swift_Mime_Header.html#86" title="Go to source code">toString</a>( )</code>

		<div class="description short">
			
<p>Get this Header rendered as a compliant string.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get this Header rendered as a compliant string.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>




	<table class="summary" id="constants">
	<caption>Constants summary</caption>
	<tr data-order="TYPE_TEXT" id="TYPE_TEXT">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#20" title="Go to source code"><b>TYPE_TEXT</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">2</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_TEXT" class="anchor">#</a>

			<div class="description short">
				
<p>Text headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>Text headers</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="TYPE_PARAMETERIZED" id="TYPE_PARAMETERIZED">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#23" title="Go to source code"><b>TYPE_PARAMETERIZED</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">6</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_PARAMETERIZED" class="anchor">#</a>

			<div class="description short">
				
<p>Parameterized headers (text + params)</p>

			</div>

			<div class="description detailed hidden">
				
<p>Parameterized headers (text + params)</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="TYPE_MAILBOX" id="TYPE_MAILBOX">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#26" title="Go to source code"><b>TYPE_MAILBOX</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">8</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_MAILBOX" class="anchor">#</a>

			<div class="description short">
				
<p>Mailbox and address headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>Mailbox and address headers</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="TYPE_DATE" id="TYPE_DATE">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#29" title="Go to source code"><b>TYPE_DATE</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">16</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_DATE" class="anchor">#</a>

			<div class="description short">
				
<p>Date and time headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>Date and time headers</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="TYPE_ID" id="TYPE_ID">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#32" title="Go to source code"><b>TYPE_ID</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">32</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_ID" class="anchor">#</a>

			<div class="description short">
				
<p>Identification headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>Identification headers</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="TYPE_PATH" id="TYPE_PATH">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_Mime_Header.html#35" title="Go to source code"><b>TYPE_PATH</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">64</span></code></td>
		<td class="description"><div>
			<a href="#TYPE_PATH" class="anchor">#</a>

			<div class="description short">
				
<p>Address path headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>Address path headers</p>


			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
